OSHI is a free JNA-based (native) Operating System and Hardware Information library for Java. It does not require the installation of any additional native libraries and aims to provide a cross-platform implementation to retrieve system information, such as OS version, processes, memory and CPU usage, disks and partitions, devices, sensors, etc.

• Supported Platforms
• Downloads and Dependency Management
• Documentation
• Usage
• Supported Features
• Support
• OSHI for Enterprise
• Security Contact Information
• Continuous Integration Test Status
• How Can I Help?
• Contributing to OSHI
• Acknowledgments
• License

Supported Platforms

• Windows
• macOS
• Linux (Android)
• UNIX (AIX, FreeBSD, OpenBSD, Solaris)

Documentation

• API (javadocs)
• FAQ
• Change Log
• Performance Considerations
• Major Version Breaking Changes
• Sample Output
• Applications and Projects using OSHI

Downloads and Dependency Management

Stable Release Version

• JDK8: oshi-core-6.6.5
• JPMS: oshi-core-java11-6.6.5
• JDK6: oshi-core-3.14.0

Current Development (SNAPSHOT) downloads

• JDK8: oshi-core-6.6.6-SNAPSHOT
• JPMS: oshi-core-java11-6.6.6-SNAPSHOT

Usage

1. Include OSHI and its dependencies on your classpath.
   • We strongly recommend you add oshi-core as a dependency to your project dependency manager such as Maven or Gradle.
   • For Android, you'll need to add the AAR artifact for JNA and exclude OSHI's transitive (JAR) dependency.
   • See the FAQ if you encounter NoClassDefFoundError or NoSuchMethodError problems.
2. Create a new instance of SystemInfo
3. Use the getters from SystemInfo to access hardware or operating system components, such as:

SystemInfo si = new SystemInfo();
HardwareAbstractionLayer hal = si.getHardware();
CentralProcessor cpu = hal.getProcessor();

See SystemInfoTest.java for examples. To see sample output for your machine:

git clone https://github.com/oshi/oshi.git && cd oshi

./mvnw test-compile -pl oshi-core exec:java \
  -Dexec.mainClass="oshi.SystemInfoTest" \
  -Dexec.classpathScope="test"

Some settings are configurable in the oshi.properties file, which may also be manipulated using the GlobalConfig class. This should be done at startup, as configuration is not thread-safe and OSHI does not guarantee re-reading the configuration during operation.

The oshi-demo artifact includes several proof-of-concept examples of using OSHI to obtain information, including a basic Swing GUI.

Supported Features

• Computer System and firmware, baseboard
• Operating System and Version/Build
• Physical (core) and Logical (hyperthreaded) CPUs, processor groups, NUMA nodes
• System and per-processor load, usage tick counters, interrupts, uptime
• Process uptime, CPU, memory usage, user/group, command line args, thread details
• Physical and virtual memory used/available
• Mounted filesystems (type, usable and total space, options, reads and writes)
• Disk drives (model, serial, size, reads and writes) and partitions
• Network interfaces (IPs, bandwidth in/out), network parameters, TCP/UDP statistics
• Battery state (% capacity, time remaining, power usage stats)
• USB Devices
• Connected displays (with EDID info), graphics and audio cards
• Sensors (temperature, fan speeds, voltage) on some hardware

Support

• For bug reports, feature requests, or general questions about OSHI's longer term plans, please create an issue.
• For help integrating OSHI into your own project or maintainer code review of your PRs, tag @dbwiddis in issues or pull requests on your project site.
• For "how to" questions regarding the use of the API, consult examples in the oshi-demo project, create an issue, or search on Stack Overflow using the oshi tag, asking a new question if it hasn't been answered before.
• To say thanks to OSHI's primary maintainer, you can sponsor him or buy him a coffee.

OSHI for Enterprise

Available as part of the Tidelift Subscription

The maintainers of OSHI and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.

Security Contact Information

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

Continuous Integration Test Status

How Can I Help?

OSHI originated as a platform-independent library that did not require additional software and had a license compatible with both open source and commercial products. We have developed a strong core of features on major Operating Systems, but we would love for you to help by:

• Testing! Our CI testing is limited to a few platforms. Download and test the program on various operating systems/versions and hardware and help identify gaps that our limited development and testing may have missed. Specific high priority testing needs include:
  • Windows systems with over 64 logical processors
  • Raspberry Pi
  • Less common Linux distributions
• Contributing code. See something that's not working right or could work better? Help us fix it! New contributors are welcome.
• Documenting implementation. Our Wiki is sparse and the oshi-demo artifact is a place to host proof-of-concept ideas. Want to help new users follow in your footsteps?
• Suggesting new features. Do you need OSHI to do something it doesn't currently do? Let us know.

Contributing to OSHI

• How to Contribute
• How to Release

Acknowledgments

Many thanks to the following companies for providing free support of Open Source projects including OSHI:

• SonarCloud for a range of code quality tools
• GitHub Actions, AppVeyor, and Cirrus CI for continuous integration testing
• The jProfile Java Profiler used to eliminate CPU bottlenecks

License

This project is licensed under the MIT License.